home *** CD-ROM | disk | FTP | other *** search
/ Gamers Delight 2 / Gamers Delight 2.iso / Aminet / game / role / ldb3_0demo.lzh / docs < prev    next >
Text File  |  1993-04-01  |  19KB  |  443 lines

  1.          Integrated Legends Database V 3.0 for Amiga computers
  2.          ------------------------------------------------------
  3.  
  4. UPGRADING FROM AN OLD VERSION - FLOPPY DISK SETUP
  5.    Version 3.0 comes on two disks; a program disk and a data disk.
  6. To upgrade, boot with the new version and bring up a CLI window.
  7. Insert the disk with your OLD data directory on it in df0: (or df1:
  8. if you have two or more drives), and type 
  9. "copy df0:data DATA: all quiet".  If you have two or more drives, 
  10. type in "copy df1:data DATA: all quiet".
  11. Then, for each of your old maps, type in "update nnnn" where nnnn
  12. is the save name of your old map file.
  13.    If you created any other directories, you should be familiar
  14. with AmigaDOS already and should have no trouble copying them over
  15. to the data disk (there isn't much space left on the new program 
  16. disk).
  17.  
  18. UPGRADING FROM AN OLD VERSION - HARD DRIVE SETUP
  19.    Basically, all you have to do is copy the contents of the new disk
  20. to wherever you previously installed the database.  This could be 
  21. accomplished by typing in:
  22. "copy df0:#? games:legends/"
  23.  
  24. Then, for each of your old maps, type in "update nnnn" where nnnn
  25. is the save name of your old map file.
  26.    If you created any other directories, you should be familiar
  27. with AmigaDOS already and should have no trouble copying them over
  28. to your data directory.
  29.  
  30. SYSTEM REQUIREMENTS:
  31.    Any Amiga series computer. A hard drive is NOT necessary.
  32. If you own an Amiga 1000, you must have more than 256 Kilobytes of RAM.
  33. 1 Megabyte of RAM is optimal for version 3.0. The program works 100% 
  34. in a WB2.04 environment, I am not sure how well it works under 3.0,
  35. although it should work nicely.  Comments on the program's performance
  36. in this environment would be much appreciated.
  37.  
  38.    For single-floppy users, I have created a small file called "ramc".
  39. It is run automatically on bootup and places certain often used commands
  40. into ram.  It makes certain operations much speedier and cuts down on
  41. disk swapping.
  42.  
  43. HARD DISK INSTALLATION - NEW USERS:
  44.    The database program is set up in a workbench environment. It does not
  45. need to be installed if you plan to run it off the floppy. However, to
  46. install the program on your hard drive, the following procedure should
  47. be adequate:
  48.  
  49. From the WorkBench, make a copy of the Empty drawer and rename it to
  50. whatever you deem appropriate. 
  51.  
  52. Then, from the CLI (open it if necessary), type:
  53.  
  54. 1> copy df0:#? dh0:<new directory name> quiet
  55. 1> makedir dh0:<new directory name>/data
  56. 1> copy df0:data dh0:<new directory name>/data all quiet
  57.  
  58. You do *not* need copies of the following files:
  59.    Preferences, Printer.info, CLI.info
  60.  
  61. Two more things need to be done. Use a text editor to edit the
  62. startup-sequence on your hard drive, and add the line:
  63.  
  64. assign DATA: dh0:<new directory name>/data
  65.  
  66. Also, you must have a temporary directory (preferably on-disk) set up
  67. somewhere.  To do this, type in:
  68.  
  69. makedir <temporary directory name>
  70.  
  71. and add the line:
  72.  
  73. assign T: <temporary directory name>
  74.  
  75. to your startup-sequence.
  76.  
  77. After this procedure, reboot.
  78.  
  79.  
  80. CONVERTING MAPS FROM VERSION 1.0
  81.    Before you try the conversion, back up all your data files !!
  82.    Just in case...
  83.  
  84.    Version 3.0 is fully backwards compatible with version 1.0. However,
  85. if you have any maps which were created using 1.0 I urge you to follow
  86. these instructions, especially if you are playing in more than one
  87. Legends module:
  88.  
  89. 1. Boot your computer with the new version. Open the CLI window.
  90. 2. rename all of your old _items files to sensible names such as coa_items
  91.    or rti_items.
  92. 3. assign DATA: to your old data directory. Run the conversion progam for
  93.    each of your old maps.
  94.    Repeat step 3 for all of your old data directories.
  95. 4. copy all old data files into the new data directory, either:
  96.    a) the "data" directory on your copy of the distribution disk, if you
  97.       plan to run from the floppy, or
  98.    b) the new data directory on your hard drive. (See installing the
  99.       Database on a hard drive)
  100. 5. Finally, delete the _strings file from your new data directory. (This
  101.    is not actually necessary, but saves about 10K of disk space.)
  102.  
  103. I sincerely apologize to those 1.0 owners who are sweating over the map
  104. conversion. I didn't appreciate certain limitations that I was programming
  105. into the database until it was too late - these have been fixed and future
  106. releases will require little or no effort to use old maps.
  107.  
  108.  
  109.  
  110.                               USING THE PROGRAM
  111.                               -----------------
  112.  
  113. 1. The main screen
  114.    The main screen contains the following:
  115.    
  116.    * a portion of the actual map is shown in a box in the upper left.
  117.      In this version, different force types have different icons, 
  118.      various terrain patterns are available, and roads and rivers are
  119.      clearly shown.
  120.    
  121.    * province information (if you have created or loaded a map) will be
  122.      shown on the right hand side of the screen.
  123.    
  124.    * the grey box below the map is the command box.  Normally it is 
  125.      blank; slecting a command (via keypress) will jump straight to said
  126.      command.  The 'HELP' key will list all available options or sub-
  127.      options.
  128.      Pressing 'ESCAPE' will abort the current command sequence.
  129.    
  130.    If the cursor is over a province with one or more locations, it is 
  131.    possible to view the "top" (first listed) force by pressing ENTER,
  132.    or double-clicking on the province with the mouse.  To view another
  133.    force in the same province, click on the force name in the province
  134.    overview, or just (V)iew it.
  135.    
  136.    Terrain entry has been greatly simplified: while the left mouse 
  137.    button is down, pressing a key will change the terrain of the 
  138.    selected province to whatever terrain matches the keypress.
  139.    (For example, if Swamp is represented by the symbol 'V', pressing
  140.    that key with the mouse button down will change the current province's
  141.    terrain to Swamp).
  142.    
  143.    To make a province coastal from the map window, press '1' while 
  144.    holding down the LMB.
  145.    
  146.    To make a province a powerpoint, press '2' while holding down the
  147.    LMB. The province will be outlined in a nice red box.  This really
  148.    isn't very satisfactory, and may be changed.
  149.    
  150.    Also, clicking on a province will move the cursor there. 
  151.  
  152. 1.1 Using the Menus
  153.       Most menu selections available are shortcuts to different commands.
  154.    The "Output" menu allows the user to toggle redirection of output
  155.    from reports and searches to any combination of the screen, printer,
  156.    and output file.
  157.       When you have "activated" a file or your printer, ALL reports 
  158.    generated will go to the specified output, whether the report comes
  159.    from a direct report or as the result of a search.
  160.  
  161.       Currently, all reports will go to at least the screen.
  162.       
  163.  
  164. 2. Commands
  165.  
  166. Note: all commands that could potentially remove the current map from the
  167. display (such as (N)ew) will be preceeded by a prompt asking whether or
  168. not you wish to save the current map file.
  169.  
  170. (P)roject   Brings up another menu:
  171.  
  172.    (N)ew    Create a new map. You will be prompted for size, name, and
  173.             item file to use.  The program does not initialize the terrain 
  174.             table to the defaults, sorry.  You will have to activate
  175.             the defaults yourself (see the 'T' command).
  176.  
  177.    (L)oad   Load a map from the DATA: directory.  I apologize for the slow
  178.             speed of map loading and saving, but it was necessary to use 
  179.             the disk for backing store due to the large size of the map.
  180.             On a system with lots of memory (>1 MB) or a hard disk, you 
  181.             won't notice much of a slowdown.  1MB floppy systems *will* be
  182.             slow (but, as a bonus, the program works. :)
  183.  
  184.    (Q)uit   Exit the program.
  185.  
  186. The following commands are only available if you have loaded or created a
  187. map:
  188.  
  189.    (S)ave   Save the map currently being worked on. The name can be up
  190.             to 8 characters long and contain no extensions. Note that the
  191.             name you call the save file does NOT have to be the same name
  192.             that you give the map. For example, one of my maps is called
  193.             "Legends - crown of Avalon #5" and the save name is "coa5".
  194.    
  195.    (P)rint Map print a section of the map to your printer, a file, or
  196.             both depending on what output options you have selected (see
  197.             1.1. above)
  198.  
  199.    (C)hange ID allows you to globally change a common item ID number from
  200.             X to Y. Use this command after finding out the real ID number
  201.             of a common item/status/training/etc that you had previously
  202.             given a "dummy" ID number. 
  203.  
  204.  
  205. (!)         Toggle optimized saving on and off. Once in awhile,
  206.             particularly after adding a large number of characters or
  207.             locations, you should use this command and then save the map.
  208.  
  209. (E)dit prov Edit the province indicated by the cursor.
  210.             Clicking in a box, or pressing the highlighted letter of that
  211.             box's name, will allow you to edit the contents of the box. 
  212.             Rivers and roads may be toggled on and off by clicking on the
  213.             appropriate direction.  Powerpoints and coastal status may
  214.             be toggled on and off with the LMB or hotkey.
  215.  
  216. (T)errain   Edit the terrain names, keys, and graphic symbols.
  217.             Clicking on the name of a terrain type displayed will activate
  218.             that terrain; after that, any keypress will change the terrain
  219.             key, and clicking on a terrain icon will change the icon
  220.             for the selected terrain type.
  221.             The 'DEFAULT' button will give you a default terrain table.
  222.             WARNING: If the "Deafult" option is selected with a non-blank
  223.             terrain table, strange things may happen (forests will turn 
  224.             into swamps, mountains will become plains, etc, etc).
  225.             The 'NAME' button allows you to change the name of the
  226.             selected terrain type.
  227.             'ESC' will exit, as usual.
  228.  
  229. (M)ove to   Position the cursor at a specific province.
  230.  
  231. (D)elete    Delete a character, location, guild, or market.
  232.  
  233. (V)iew      This replaces the "Report" and "Add/Edit" commands in earlier
  234.             versions.  With this command, you may generate a report on 
  235.             a force, character, guild, or marketplace.  It is possible to
  236.             edit the object you are viewing; in fact this is now the ONLY
  237.             way to edit a game object.
  238.             While viewing/editing an object, you may (V)iew another 
  239.             without exiting the current report.  (saves wear & tear 
  240.             on the Escape key).
  241.  
  242. (B)urst char This command is good for adding many characters to a single
  243.             location very quickly, which is useful when you first run
  244.             across a major location or a ruin.
  245.  
  246. (S)earch    This brings up another menu:
  247.    (R)esource  - search all provinces and marketplaces for a specific
  248.                   item type, which can be anything (dwarven slaves for
  249.                   example).
  250.    (C)hars     - multiparameter character search.  Can search on skill,
  251.                   race, culture, special status, etc, or any combination
  252.                   of the above (for example, "find all human barbarians
  253.                   with at least level 5 bard skill, near Tamor Elosium")
  254.    (F)orce     - multiparameter force search. Much like Character search.
  255.    (G)uild     - search for a guild type
  256.    (M)arket    - search for markets ( proximity search only; use (R)esource
  257.                   search to find specific items).
  258.    coat of (A)rms - find all or a subset of game objects (forces, guilds,
  259.                  characters, etc) flying a particular coat of arms, or
  260.                  owned by a certain character.
  261.  
  262.    Using the multiparameter searches is fairly intuitive.  The database
  263.    will search ALL objects of the type you are searching, with the 
  264.    following search restrictions:
  265.       i.   Fields that were left blank are not considered for the search.
  266.       ii.  A field set to "Any" will find any non-zero value, which may
  267.            be useful for finding all Nomad Orcs with "a special status"
  268.            (no status in particular).
  269.       iii. Any field with a value other than "Any" requires an exact
  270.            match.
  271.       
  272.    During searches, pressing the <Esc> key will halt the search.
  273.  
  274.  
  275. 2.1 ARROW KEYS:
  276.    Moving around the map is accomplished via the arrow keys. Any information
  277. you may have about the current province is displayed on the righthand side
  278. of the screen.
  279.  
  280.  
  281.                            ----------------------
  282.  
  283. 3 Miscellany
  284.  
  285. 3.1 PROVINCE DATA:
  286. Each province may contain data on the following:
  287. * fertility value
  288. * lumber rating               * iron rating
  289. * stone rating                * cleared land
  290. * up to 4 special resources.
  291. * herd information
  292. * rivers and roads
  293.  
  294.  
  295. 3.2 "Last Update" fields:
  296.    This is an optional field, intended for the purpose of indicating how
  297. recent or reliable information is. On my maps, this field contains the turn
  298. number that said information was aquired.
  299.  
  300.  
  301. 3.3 Marketplaces
  302.    Marketplace slots are set "to sell" by default. If a market is open
  303. to buy an item, indicate this by entering the negative of the buying
  304. price (for example, if the marketplace was purchasing bows for 10 crowns
  305. each, you would enter -10 for the price.)
  306.  
  307.  
  308. 3.4 Common Item/Status numbers:
  309.    When entering an item, special status, resource, soldier type, etc. as
  310. found in the Legends rulebook, simply enter the number (e.g. "201" for
  311. human). Use the <return> or <enter> key to accept a default.
  312.  
  313.    While entering a common item, pressing the "help" key will activate
  314. a help window with the item file displayed. The following keys then take on
  315. certain attributes:
  316.    UP ARROW         - scrolls up the list
  317.    DOWN ARROW       - scrolls down the list
  318.    HELP             - deactivates the item list
  319.    SHIFT+UP ARROW   - top of list
  320.    SHIFT+DOWN ARROW - bottom of list
  321.  
  322.    If you enter an item number for which there is no description, you will
  323. be prompted for one, and the item will then be added to your item file. Be
  324. patient, this can take a while if your item file is large and you are 
  325. running the program from a floppy disk.
  326.    The item list will attempt to follow you around.  For example, if you
  327. are typing in "201" (for human), the item list will position itself at
  328. that entry.  This can't be turned off, sorry.  If it is really annoying,
  329. send me mail.  I'll get to it. :)
  330.  
  331. 3.5 Character stats:
  332.    When entering an attribute, loyalty rating, or prestige, either an
  333. actual number (e.g. "12") or a maximum four letter description (e.g.
  334. "<avg" for below average) can be used.
  335.  
  336. 3.6 Churches:
  337.    When entering the guild type for a church, the number to enter is 10
  338. plus the religion number.
  339.  
  340. 3.7 Identifying game objects
  341.    When asked to identify a location, character, guild, or marketplace,
  342. you have two options - either enter the id number, or type in the name. If
  343. you type in only part of the name, the program will search through all
  344. characters, markets, etc. and create a list of possible matches. After you
  345. are presented with the first name in the list, you may scroll up and down
  346. the list with the arrow keys, accept a name by pressing CR, enter another
  347. search pattern, or enter an actual ID number.
  348.    Currently, the program will only keep a list of 100 names that match
  349. your search pattern. Any more will be lost, so try and enter a reasonable
  350. search pattern (i.e. "a" is not a good search pattern).
  351.  
  352. 3.8 Disk Management:
  353.    Supplied with the distribution disk is a large selection of printer
  354.    drivers. These take up a lot of space. Select one that works with
  355.    your printer (generic probably will), and DELETE THE REST. An easy
  356.    way to do this is:
  357.  
  358. 1> copy devs/printers/<name> to ram:
  359. 1> delete devs/printers/#? quiet
  360. 1> copy ram:<name> devs/printers
  361.  
  362.    Where <name> is the name of the printer driver you have chosen.
  363.  
  364.    On a hard drive, of course, this is irrelevant.
  365.  
  366.  
  367.  
  368.                             ------------------
  369.  
  370. SPECIAL KEYS:
  371.    Three keys play a large role in getting around the database:
  372.  
  373.    <enter/return>    used as a terminator when entering data or accepting
  374.                      a default
  375.    <space bar>       used during searches to find the next match
  376.    <escape>          usable at almost any point to 'back up' to the last
  377.                      menu or option, or quit a search.
  378.                      
  379. MOUSE/KEYBOARD USE:
  380.    The report screens have many buttons and boxes.  To edit information
  381. in the boxes, simply click in them with the left mouse button, OR press
  382. the corresponding key.  I have used light green to indicate the relevent
  383. keypresses, but not quite all of them have been implemented yet.
  384.    When in doubt, click on it with the LMB.  You can't do anything 
  385. terrible (but if you manage to crash the program, let me know).
  386.  
  387.                            --------------------
  388.  
  389. 4.0 The common item files:
  390.  
  391.    These files contain lists of Legends "items" used by the database. There
  392. are many, many items that I have not discovered yet, and so they are not
  393. in the item files.  There are three pre-made item files, called coa_items,
  394. rti_items, and nic_items.  Use whichever is appropriate for your module,
  395. and/or edit the above files.
  396.  
  397.    If you decide to edit an item file, please keep in mind the following
  398. restrictions:
  399.  
  400. 1) All items must be in numerical order (lowest to highest). The program
  401.    will abort if this condition is not met.
  402.  
  403. 2) I have established a convention for putting diety names in the item
  404.    files. Add 2000 to the religion number, that is the item # of of that
  405.    religion. For example,
  406.  
  407.    Crown of Avalon                  Realm of Immortals
  408.    ---------------                  ------------------
  409.    2000,Atheist                     2000,Atheist
  410.    2001,Alevereth                   2001,Vol
  411.    2002,Rasinoah                    2002,Valandara
  412.    etc...
  413.  
  414. 3) Items and statuses without ID numbers:
  415.    Let's say that one day your character is hacking and slashing an
  416.    opposing army to bits, when suddenly, thanks to her power 2 mithril
  417.    sword, she morphs into a Local Hero. Wow! Great! But what is the
  418.    ID# of that status?
  419.    I am suggesting the following convention: number any unknown items
  420.    or statuses starting from ID# 2100 and up. e.g.
  421.  
  422.    2100,Local Hero
  423.    2101,Greater Enchanted
  424.    2102,City Watch               (a troop type found in RTI)
  425.    etc...
  426.  
  427.    You may use the (C)hange ID command from the (P)roject menu to globally
  428.    alter an ID number from X to Y, which is useful when/if you discover the
  429.    real ID number.
  430.  
  431. Restriction 1) may disappear in future versions.
  432.  
  433.                            ---------------------
  434.  
  435.    I have tried to make this program as user-friendly as possible. When in
  436. doubt, hit the three 'special' keys mentioned above - something will
  437. probably happen. If you think you have found a bug, or have a suggestion
  438. for improving the database, please contact me at:
  439.  
  440. Gordon Lipford, 8512-147 Street, Edmonton, AB, T5R 0X8.
  441. Internet address: glipford@undergrad.math.uwaterloo.ca
  442.  
  443.